Returns information about a tenant's Pulse clients
{ getPulseNodesForTenant }
Returns a listing of all Pulse clients for a given tenant
Method
/API3/dataSources/getPulseNodesForTenant
- Enterprise Admin
- Domain Admin
Input Parameters
Name
TenantId
Type
string
Description
The Tenant's system ID
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
Result list of pulse objects. Note that the response is returned as a list of items of this object type.
Notes
Use this method to retrieve the status and information on each Pulse client registered to a given tenant
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/dataSources/getPulseNodesForTenant" \
-d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;
import java.util.*;
import java.time.*;
public class DataSourcesServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
// Initialize the tenantId parameter object for the call
String tenantId = tenantId_example; // Create the input object for the operation, type: String
try {
// "array[PulseClientData]" is only psaudo-code to symbolize list of type and not the actual usage
array[PulseClientData] result = apiInstance.getPulseNodesForTenant(tenantId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#getPulseNodesForTenant");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const tenantId = tenantId_example; // {String}
api.getPulseNodesForTenant(tenantId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class getPulseNodesForTenantExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new DataSourcesServiceApi();
// Initialize the tenantId parameter object for the call
var tenantId = tenantId_example; // Create the input object for the operation, type: String |
try {
// Returns a listing of all Pulse clients for a given tenant
// "array[PulseClientData]" is only psaudo-code to symbolize array of type and not the actual usage
array[PulseClientData] result = apiInstance.getPulseNodesForTenant(tenantId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.getPulseNodesForTenant: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = DataSourcesServiceApi(api_client)
# Initialize the tenantId parameter object for the call
tenantId = tenantId_example # String |
try:
# Returns a listing of all Pulse clients for a given tenant
api_response = api_instance.get_pulse_nodes_for_tenant(tenantId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->getPulseNodesForTenant: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$tenantId = tenantId_example; // String |
try {
$result = $api_instance->getPulseNodesForTenant($tenantId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->getPulseNodesForTenant: ', $e->getMessage(), PHP_EOL;
}
?>